home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / games_a / wadutils.zip / README.TXT < prev   
Text File  |  1996-04-18  |  9KB  |  214 lines
  1. WADUTILS v1.0
  2.  
  3. README for:
  4. INFO
  5. MAKEWAD
  6. BREAKWAD
  7.  
  8. PLEASE NOTE:
  9. Apogee(tm) and 3DRealms(tm) do not in ANY WAY support these programs;
  10. they are not the authors.  PLEASE do not mail them any questions about
  11. this software; instead, direct all inquiries to the author, Derek Greentree,
  12. <derekg@icanect.net>.  Thank you!
  13.  
  14. WADUTILS v1.0, is, of course, freeware!  You may distribute these
  15. files as long as they are in their original form: complete, intact,
  16. and unaltered.  The package includes:
  17. INFO.EXE, MAKEWAD.EXE, BREAKWAD.EXE, DOS4GW.EXE, and README.TXT
  18.  
  19. P.S. If you make external wadfiles with this and distribute them in
  20. a .RTC or .RTL level pack, please include the name of this package
  21. in the editor(s) used section of the author file(RT?_AUTH.TXT); make
  22. a simple programmer(me) happy.
  23.  
  24. TOC
  25. {1} What are these programs?
  26. {2} The Resource Textfile
  27. {3} Building PWADs for use with new RotT levels(.RTLs) and COMM-BAT levels
  28. (.RTCs)! 
  29. {4} Where do I go from here?
  30. {5} About the Author/How to Contact the Author
  31.  
  32.  
  33. {1} What are these programs?
  34. INFO is a program which displays the information tables for
  35. a Rise of the Triad(tm) WADfile.  Its usage is:
  36. INFO <WADFILE>
  37. where <WADFILE> is the name of a WADfile in RotT format(i.e. DARKWAR.WAD).
  38. INFO will pause at every new screen.  When INFO pauses, press "Q"(or "q")
  39. to quit, or any other key to continue the listing.
  40.  
  41. MAKEWAD is a program which will generate a RotT WADfile.
  42. Its usage is :
  43. MAKEWAD <RES LIST> <OUTFILE>
  44. where <RES LIST> is a resource textfile(see below) and <OUTFILE> is
  45. the name of the WADfile to be generated.
  46. MAKEWAD will also optionally take a fourth parameter.  If you enter
  47. the letter "r" on the command line after <OUTFILE>, MAKEWAD will
  48. delete the resource after it builds it into the wadfile.
  49.  
  50. BREAKWAD is a program which will decompose a RotT WADfile.
  51. Its usage is:
  52. BREAKWAD <WADFILE> <RES LIST>
  53. where <WADFILE> is the name of the WADfile to be decomposed, and
  54. <RES LIST> is a resource textfile(see below), which will be
  55. built upon running.
  56.  
  57. {2} The Resource Textfile
  58. This is a very simple textfile which tells MAKEWAD the number
  59. of lumps in the WADfile to be made, and the filename of each of those
  60. lumps.
  61. A lump is a file resource.  For example, when RotT loads a texture
  62. called WALL1, this texture is a lump.
  63. The resource textfile has the following format:
  64. numlumps(N)
  65. filename1
  66. filename2
  67. .
  68. .
  69. .
  70. filenameN
  71.  
  72. So, if you wanted to make a new WADfile with only 2 resources, and
  73. you wanted the data for those resources to come from the files
  74. STEVE.TXT and JOHN.TXT, then your resource file would look like this:
  75.  
  76. 2
  77. STEVE.TXT
  78. JOHN.TXT
  79.  
  80. The resource textfile is very rigid.  Comments are NOT supported,
  81. at least not in this version.  Be sure that when you make your
  82. resource textfile you adhere to the format above, or you will
  83. get unpredictible results.
  84.  
  85. BREAKWAD makes a resource file exactly as this format
  86. specifies.  However, there are
  87. complications, namely :
  88. 1) RotT stores the id for their lumps as a string with 8 places; therefore,
  89.    the extensions are automatically cut off files when they are made
  90.    into a lump, and null characters are added to the first part
  91.    of the filename.
  92.    Therefore, for our example resfile above, a wad would be
  93.    generated having two lumps with the id's(ignore the quote marks):
  94.    "STEVE   " and "JOHN    ".(the spaces here are actually null chars)
  95. 2) On account of number 1, whenever you run BREAKWAD on a wadfile, the
  96.    original extension of the files generated is unknown, so BREAKWAD
  97.    filters out nulls and appends ".XXX".  BREAKWAD will always use
  98.    ".XXX" unless a file of the same name already exists.  For example,
  99.    in DARKWAR.WAD, the resource TSPHERE1 appears twice.  BREAKWAD will
  100.    write the first one as TSPHERE1.XXX, and the second as TSPHERE1.XXZ.
  101.  
  102.    Again using the sample WADfile described above, BREAKWAD would
  103.    create two files, STEVE.XXX and JOHN.XXX .  Also, the
  104.    resource file generated would be:
  105.    2
  106.    STEVE.XXX
  107.    JOHN.XXX
  108.    The next version of these utilities(if there is one) should have a
  109.    little smarter extension control.
  110.  
  111. SPECIAL NOTE:
  112.   Since the .RTS files used in Rise of the Triad and Duke Nukem 3D
  113. are, for all technical purposes, WADfiles, the utils can be used
  114. to make and break Remote Ridicule Files.
  115.  
  116. {3} Building PWADs for use with new RotT levels(.RTLs) and COMM-BAT
  117. levels(.RTCs)
  118. Yes, now you can distribute new textures, sounds, songs, etc. with
  119. your Rise of the Triad Levels.  RotT is set up so that a properly
  120. generated and formatted WADfile with a IWAD id can be loaded
  121. (with the command syntax "ROTT file <WADFILE>"), and if RotT
  122. finds a resource it needs, it will use one from the external wad file,
  123. if it is present.  The upshot of all this is that you can make
  124. a WADfile with altered resources and distribute it with your
  125. .RTC and .RTL level packs.  For an example of the usefulness of this
  126. feature, consider the following:
  127. You have made a level pack with an unusual theme.  The only problem
  128. is that you think some different sounds would really add to the
  129. atmosphere of your pack.  Now, you can simply record a new .VOC file,
  130. and use it in an add-on wad.  For example, the resource DA_SAY1.XXX,
  131. from DARKWAR.WAD, is a .VOC file that is played when you are
  132. fighting the boss General Darian.  Replace this file, and RotT will
  133. play YOUR .VOC file!  To do this, you would simply create a new wadfile
  134. with this resource by running MAKEWAD with a textfile like this:
  135.  
  136. 3
  137. DIGISTRT.XXX
  138. DA_SAY1.VOC
  139. DIGISTOP.XXX
  140.  
  141. The DIGISTRT/DIGISTOP are the section headers, and are generated from
  142. zero-length files.  I am unsure whether or not they are required,
  143. I just use them because RotT does.  For more exmaples of what these
  144. resources are, see the next section.
  145.  
  146. The SETUP utility distributed with RotT supports command-line option
  147. passing.  So, to use both a new .RTC file and a new WADfile, one would
  148. type
  149. SETUP file mywad.wad
  150. (mywad is the name of your wadfile, duh)
  151. and then proceed through the menu system normally to use an alternate
  152. level file.
  153.  
  154.  
  155. {4} Where do I go from here?
  156. Take a look at the resource textfile generated by breaking down
  157. a WADfile, like DARKWAR.WAD.  You will see groups of files encased
  158. by markers, which are written to your hard drive as zero-length files.
  159. Examples are WALLSTRT, WALLSTOP, ANIMSTRT, ANIMSTOP, etc.
  160. Below I will discuss the most easily "editable" of these files.
  161. WALLSTRT/WALLSTOP
  162. Files between these headers are raw screen data; that's it.  If you
  163. can program, then if you open these files and write them straight to
  164. video memory(after setting the palette), you will see that they
  165. are wall textures.
  166. DIGISTRT/DIGISTOP
  167. These are sounds used in RotT.  They are standard .VOC files, and can be
  168. edited and replaced as you wish.
  169. SONGSTRT/SONGSTOP
  170. These are MIDI songs.  Once again, they can be replaced.  ( I used the
  171. Dopefish theme, and a bunch of other neat MIDIs )
  172.  
  173. "SPECIAL" resources
  174. PAL.XXX - This is the palette used in RotT
  175. LICENSE.XXX - This is the legal stuff for RotT(don't mess with it).
  176.  
  177. WARNING:
  178. Feel free to change the file extensions freely.  However, a reminder,
  179. if you change the file NAME, you are also changing its id in the WADfile.
  180. ----
  181. Other files in the game are discussed in the file HACKROTT.COM, which I
  182. strongly suggest you read.
  183. Any industrious programmer should be able to write a simple editor
  184. for the graphics resource files. (If anybody has plans to do this,
  185.                                   please let me know.)
  186.  
  187. {5} About the Author/Contacting the Author
  188. I am Derek Greentree, also the author of the RotT FAQ v3.0.
  189. I can be reached via email at
  190. derekg@icanect.net
  191. or via the WWW at
  192. http://www.icanect.net/~derekg/
  193. Be aware that for the WWW site above you will need a frames capable browser.
  194. Miscellaneous technical info you probably don't care about:
  195. These programs were written in C and compiled with Watcom C/C++ v10.5,
  196. and they use Tenberry Software's DOS/4GW Protected Mode Runtime Extender.
  197.  
  198. "And now the questions.  Do I kill them?  become their friend?  Do I eat
  199. them?  raw or well done?  Do I trick them?  I don't think they're that
  200. dumb!  Do I join them?  I guess that's the one."
  201.  
  202.  
  203. Rise of the Triad is (c)1995 Apogee Software Ltd.
  204. These programs are (c)1996 Derek Greentree.
  205. DOS/4GW (c)1990-1994 Rational Systems Inc.
  206. DISCLAIMER:
  207. Even though it is very unlikely, I cannot be held responsible for any 
  208. damage caused by using these programs.
  209.  
  210.  
  211.  
  212.  
  213.  
  214.